<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>SatStress.SatStress.Satellite</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="SatStress-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/satstress">SatStress</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="SatStress-module.html">Package&nbsp;SatStress</a> ::
        <a href="SatStress.SatStress-module.html">Module&nbsp;SatStress</a> ::
        Class&nbsp;Satellite
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="SatStress.SatStress.Satellite-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Satellite</h1><p class="nomargin-top"><span class="codelink"><a href="SatStress.SatStress-pysrc.html#Satellite">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">Satellite</strong>
</pre>

<hr />
<p>An object describing the physical structure and context of a 
  satellite.</p>
  <p>Defines a satellite's material properties, internal structure, orbital
  context, and the tidal forcings to which it is subjected.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="SatStress.SatStress.Satellite-class.html" 
      class="link">Satellite</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="SatStress.SatStress.Satellite-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">satFile</span>)</span><br />
      Construct a Satellite object from a satFile</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="SatStress.SatStress-pysrc.html#Satellite.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="SatStress.SatStress.Satellite-class.html#mass" class="summary-sig-name">mass</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Calculate the mass of the satellite.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="SatStress.SatStress-pysrc.html#Satellite.mass">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="radius"></a><span class="summary-sig-name">radius</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Calculate the radius of the satellite (the sum of the layer 
      thicknesses).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="SatStress.SatStress-pysrc.html#Satellite.radius">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="density"></a><span class="summary-sig-name">density</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Calculate the mean density of the satellite in [kg m^-3].</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="SatStress.SatStress-pysrc.html#Satellite.density">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="surface_gravity"></a><span class="summary-sig-name">surface_gravity</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Calculate the satellite's surface gravitational acceleration in [m 
      s^-2].</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="SatStress.SatStress-pysrc.html#Satellite.surface_gravity">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="orbit_period"></a><span class="summary-sig-name">orbit_period</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Calculate the satellite's Keplerian orbital period in seconds.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="SatStress.SatStress-pysrc.html#Satellite.orbit_period">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="mean_motion"></a><span class="summary-sig-name">mean_motion</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Calculate the orbital mean motion of the satellite [rad s^-1].</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="SatStress.SatStress-pysrc.html#Satellite.mean_motion">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="SatStress.SatStress.Satellite-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Output a satellite definition file equivalent to the object.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="SatStress.SatStress-pysrc.html#Satellite.__str__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Variables</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">list</span>
    </td><td class="summary">
        <a href="SatStress.SatStress.Satellite-class.html#layers" class="summary-name">layers</a><br />
      a list of <a href="SatStress.SatStress.SatLayer-class.html" 
      class="link">SatLayer</a> objects, describing the layers making up 
      the satellite.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">float</span>
    </td><td class="summary">
        <a href="SatStress.SatStress.Satellite-class.html#nsr_period" class="summary-name">nsr_period</a><br />
      the time it takes for the decoupled ice shell to complete one full 
      rotation [s], corresponds to <code>NSR_PERIOD</code> in the input 
      file.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">int</span>
    </td><td class="summary">
        <a href="SatStress.SatStress.Satellite-class.html#num_layers" class="summary-name">num_layers</a><br />
      the number of layers making up the satellite, as indicated by the 
      number of keys within the satParams dictionary contain the string 
      'LAYER_ID'.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">float</span>
    </td><td class="summary">
        <a name="orbit_eccentricity"></a><span class="summary-name">orbit_eccentricity</span><br />
      the satellite's orbital eccentricity, corresponds to 
      <code>ORBIT_ECCENTRICITY</code> in the input file.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">float</span>
    </td><td class="summary">
        <a name="orbit_semimajor_axis"></a><span class="summary-name">orbit_semimajor_axis</span><br />
      semimajor axis of the satellite's orbit [m], corresponds to 
      <code>ORBIT_SEMIMAJOR_AXIS</code> in the input file.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">float</span>
    </td><td class="summary">
        <a name="planet_mass"></a><span class="summary-name">planet_mass</span><br />
      the mass of the planet the satellite orbits [kg], corresponds to 
      <code>PLANET_MASS</code> in the input file.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">dict</span>
    </td><td class="summary">
        <a name="satParams"></a><span class="summary-name">satParams</span><br />
      dictionary containing the name value pairs read in from the input 
      file.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">file</span>
    </td><td class="summary">
        <a name="sourcefile"></a><span class="summary-name">sourcefile</span><br />
      the file object which was read in order to create the <a 
      href="SatStress.SatStress.Satellite-class.html" 
      class="link">Satellite</a> instance.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">str</span>
    </td><td class="summary">
        <a name="system_id"></a><span class="summary-name">system_id</span><br />
      string identifying the planet/satellite system, corresponds to 
      <code>SYSTEM_ID</code> in the input file.
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Properties</span></td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">satFile</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="SatStress.SatStress-pysrc.html#Satellite.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Construct a Satellite object from a satFile</p>
  <h1 class="heading">Required input file parameters:</h1>
    <p>The Satellite is initialized from a name value file (as described 
    under <a href="SatStress.SatStress-module.html#nvf2dict" 
    class="link">nvf2dict</a>).  The file must define the following 
    parameters, all of which are specified in SI (MKS) units.</p>
    <ul>
      <li>
        <b><code>SYSTEM_ID</code></b>:  A string identifying the planetary 
        system, e.g. JupiterEuropa.
      </li>
      <li>
        <b><code>PLANET_MASS</code></b>:  The mass of the planet the 
        satellite orbits [kg].
      </li>
      <li>
        <b><code>ORBIT_ECCENTRICITY</code></b>:  The eccentricity of the 
        satellite's orbit.  Must not exceed 0.25.
      </li>
      <li>
        <b><code>ORBIT_SEMIMAJOR_AXIS</code></b>:  The semimajor axis of 
        the satellite's orbit [m].
      </li>
      <li>
        <b><code>NSR_PERIOD</code></b>:  The time it takes for the 
        satellite's icy shell to undergo one full rotation [s].  If you 
        don't want to have any NSR stresses, just put INFINITY here.
      </li>
    </ul>
    <p>An example satFile is included with the SatStress package:</p>
<pre class="literalblock">
   SatStress-X.Y.Z/input/Europa.satellite
</pre>
    <p>Where X.Y.Z refers to the version numbers.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>satFile</code></strong> (file) - Open file object containing name value pairs specifying the 
          satellite's internal structure and orbital context, and the tidal
          forcings to which the satellite is subjected.</li>
    </ul></dd>
    <dt>Returns: <a href="SatStress.SatStress.Satellite-class.html" 
      class="link">Satellite</a></dt>
        <dd>a Satellite object corresponding to the proffered input file.</dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="SatStress.SatStress.NameValueFileError-class.html">NameValueFileError</a></strong></code> - if parsing of the input file fails.</li>
        <li><code><strong class='fraise'><a href="SatStress.SatStress.MissingSatelliteParamError-class.html">MissingSatelliteParamError</a></strong></code> - if a required input field is not found within the input file.</li>
        <li><code><strong class='fraise'><a href="SatStress.SatStress.NonNumberSatelliteParamError-class.html">NonNumberSatelliteParamError</a></strong></code> - if a required input which is of a numeric type is found within the 
        file, but its value is not convertable to a float.</li>
        <li><code><strong class='fraise'><a href="SatStress.SatStress.LoveLayerNumberError-class.html">LoveLayerNumberError</a></strong></code> - if the number of layers specified is not exactly 4.</li>
        <li><code><strong class='fraise'><a href="SatStress.SatStress.GravitationallyUnstableSatelliteError-class.html">GravitationallyUnstableSatelliteError</a></strong></code> - if the layers are found not to decrease in density from the core to
        the surface.</li>
        <li><code><strong class='fraise'><a href="SatStress.SatStress.ExcessiveSatelliteMassError-class.html">ExcessiveSatelliteMassError</a></strong></code> - if the mass of the satellite's parent planet is not at least 10 
        times larger than the mass of the satellite.</li>
        <li><code><strong class='fraise'><a href="SatStress.SatStress.LargeEccentricityError-class.html">LargeEccentricityError</a></strong></code> - if the satellite's orbital eccentricity is greater than 0.25</li>
        <li><code><strong class='fraise'><a href="SatStress.SatStress.NegativeNSRPeriodError-class.html">NegativeNSRPeriodError</a></strong></code> - if the NSR period of the satellite is less than zero.</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="mass"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">mass</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="SatStress.SatStress-pysrc.html#Satellite.mass">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculate the mass of the satellite. (the sum of the layer masses)</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="__str__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
    <br /><em class="fname">(Informal representation operator)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="SatStress.SatStress-pysrc.html#Satellite.__str__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Output a satellite definition file equivalent to the object.</p>
  <dl class="fields">
    <dt>Overrides:
        object.__str__
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== INSTANCE VARIABLE DETAILS ==================== -->
<a name="section-InstanceVariableDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Variable Details</span></td>
</tr>
</table>
<a name="layers"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">layers</h3>
  a list of <a href="SatStress.SatStress.SatLayer-class.html" 
  class="link">SatLayer</a> objects, describing the layers making up the 
  satellite.  The layers are ordered from the center of the satellite 
  outward, with layers[0] corresponding to the core.
  <dl class="fields">
    <dt>Type:</dt>
      <dd>list</dd>
  </dl>
</td></tr></table>
</div>
<a name="nsr_period"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">nsr_period</h3>
  the time it takes for the decoupled ice shell to complete one full 
  rotation [s], corresponds to <code>NSR_PERIOD</code> in the input file.  
  May also be set to infinity (inf, infinity, INF, INFINITY).
  <dl class="fields">
    <dt>Type:</dt>
      <dd>float</dd>
  </dl>
</td></tr></table>
</div>
<a name="num_layers"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">num_layers</h3>
  the number of layers making up the satellite, as indicated by the number 
  of keys within the satParams dictionary contain the string 'LAYER_ID'.  
  Currently this must equal 4.
  <dl class="fields">
    <dt>Type:</dt>
      <dd>int</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="SatStress-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/satstress">SatStress</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Thu Apr  3 16:42:45 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
